home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d22 / csap208b.arc / CSAP.DOC < prev    next >
Text File  |  1989-10-10  |  7KB  |  157 lines
  1.                  CSAP - Sort And Pack Directories
  2.                Version: 2.01    Date: June 4, 1987
  3.                      Author: Don A. Williams
  4.  
  5.      *********************  N O T I C E *********************
  6.      *  Contrary to the current trend in MS-DOS  software   *
  7.      *  this  program,  for whatever it is worth,  is NOT   *
  8.      *  copyrighted (with the exception  of  the  runtime   *
  9.      *  library from Datalight C)!  The program, in whole   *
  10.      *  or in part,  may be used freely in any fashion or   *
  11.      *  environment desired.  If you find this program to   *
  12.      *  be useful to you, do NOT send any contribution to   *
  13.      *  the author;  in the words of Rick Conn,  'Enjoy!'   *
  14.      *  However,  if  you make any improvements,  I would   *
  15.      *  enjoy receiving a copy of the modified source.  I   *
  16.      *  can be  reached,  usually  within  24  hours,  by   *
  17.      *  messages   on   any   of   the  Phoenix  systems,   *
  18.      *  particularly:                                       *
  19.      *                                                      *
  20.      *     Bob's Answering Machine [OPUS]                   *
  21.      *           (602) 242-3158   1200/2400 bps             *
  22.      *     The Tool Shop BBS       [PCBOARD] [PC-Pursuit]   *
  23.      *           (602) 279-2673   1200/2400 bps             *
  24.      *     The Phoenix TechLine    [PCBOARD]                *
  25.      *           (602) 936-3058   1200/2400/9600 bps        *
  26.      *     Technoids Anonymous     [PCBOARD]                *
  27.      *           (602) 899-4876   300/1200/2400 bps         *
  28.      *                                                      *
  29.      *  or on GEnie, mail address: DON-WILL                 *
  30.      *                                                      *
  31.      *  Every  effort  has  been  made to avoid error and   *
  32.      *  moderately extensive testing has  been  performed   *
  33.      *  on  this  program,  however,  the author does not   *
  34.      *  warrant it to be fit for any  purpose  or  to  be   *
  35.      *  free  from  error and disclaims any liability for   *
  36.      *  actual or any other damage arising from  the  use   *
  37.      *  of this program.                                    *
  38.      ********************************************************
  39.  
  40.  
  41. CSAP is a program to sort PC/MS-DOS directories in any  of  three 
  42. orders   and  to  write  out  the  sorted  directory.   It  is  a 
  43. replacement for my earlier SAP  which  was  written  in  assembly 
  44. language and had a number of nasty bugs!  CSAP, from version 2.02    |
  45. up,  supports  all of the options provided by SAP 3.01,  however,    |
  46. the manner of specification and the deafaults are different.         |
  47.  
  48. Changes between this documentation and  prior  versions  will  be    |
  49. indicated by 'change bars',  i.e.  the character '|' in the right    |
  50. margin.                                                              |
  51.  
  52. There is a major exception to the sort.  An  MS-DOS  system  disk    |
  53. contains  two  files that MUST be the FIRST two files in the root    |
  54. directory.  These files contain MSDOS itself and the BIOS for the    |
  55. system.  Unfortunately, there is no sure way to distinguish these    |
  56. files from any other files although usually they have the  System    |
  57. and/or Hidden attributes and their Extension is 'SYS'.  If either    |
  58. of  the first two files in the root directory have the System and    |
  59. Hidden attributes,  CSAP will assume that the disk  is  a  system    |
  60. disk and will exclude the first two files from the sort.             |
  61.  
  62.  
  63. USAGE
  64.  
  65.         CSAP [options] [directory_name]
  66.                      or
  67.         CSAP [directory_name] [options]
  68.  
  69. Both parameters are optional and,  if neither is specified,  CSAP 
  70. will sort the current directory and all elements in the directory 
  71. tree  below  it  in  ascending order on the "Name" field.  As did 
  72. SAP,  CSAP will sort all subdirectory entry  so  that  they  fall 
  73. ahead  of  any  file  entries.  The directory_name parameter,  if 
  74. supplied, specifies to CSAP the directory with which to start the 
  75. sort.  Unless otherwise instructed, CSAP will sort that directory 
  76. and all directories below it in the directory hierarchy.  
  77.  
  78. If  no disk is specified in the path name,  CSAP will work on the    |
  79. 'current' or 'default' disk, the disk shown in the MS-DOS prompt.    |
  80. If the first character of the path name,  after the optional disk    |
  81. specification, is a '\', CSAP will assume that the path starts at    |
  82. the  root directory.  If the path name does not begin with a '\',    |
  83. SAP will assume that the path starts at the  'current'  directory    |
  84. and  will prefix the specified path name with that of the current    |
  85. directory before using it.                                           |
  86.  
  87. The options provide the user with a means of controlling the sort 
  88. order.  They are as follows:
  89.  
  90.         -N    Sort on entry Name and Extension(the default).        |
  91.         -E    Sort on entry Extension then Name.                    |
  92.         -D    Sort on entry Date/Time.
  93.         -S    Sort on entry Size.
  94.         -I    Invert the  sort  order,  i.e  sort  in  descending 
  95.               order.  
  96.         -L    Sort only one level of the hierarchy.                 |
  97.         -R    Report the number of removed  "deleted"entries  and   |
  98.               the sector addresses of the directory.                |
  99.         -P    Do not remove "deleted" entries [reversed from SAP].  |
  100.  
  101. The  case  and order of the options is not important and they can 
  102. be specified individually, i.e.  
  103.  
  104.         CSAP -d -i
  105.  
  106. or combined, i.e.
  107.  
  108.         CSAP -di
  109.  
  110.  
  111. EXAMPLES:
  112.  
  113. Following are some simple examples of the use of CSAP:
  114.  
  115.         1.zzA>CSAP
  116.  
  117.             This form of the CSAP command (with no  command  line 
  118.             parameters)  will sort the "current" directory of the 
  119.             "current" or "default" disk (disk A in this  example) 
  120.             and  all  directories below it in the hierarchy.  The 
  121.             directories  will  be  sorted  in  name   order   and 
  122.             "deleted" entries will be removed.  
  123.  
  124.         2.  A>CSAP -V
  125.  
  126.             This  form  of  the CSAP command is the same as in 1.  
  127.             except that CSAP will  pause  for  user  confirmation 
  128.             before sorting each directory.  
  129.  
  130.         3.  A>CSAP \
  131.  
  132.             This  form  of  the CSAP command will sort the "Root" 
  133.             directory of the "Current" disk, in ths example, A:\.  
  134.             All directories on disk A would be sorted.  
  135.  
  136.         4.  A> CSAP \ -L
  137.  
  138.             This form would, again,  sort the "Root" directory of 
  139.             disk A but the "-L" option would limit the sorting to 
  140.             just the "Root".
  141.  
  142.         5.  A>CSAP \ -R
  143.  
  144.             This  form  of the CSAP would sort all directories on 
  145.             disk A and show,  for each  directory,  the  relative 
  146.             sectors  occupied  by the directory and the number of 
  147.             "erased" entries removed.  
  148.  
  149.         6.  A>CSAP \ -DR
  150.  
  151.             This form of the CSAP command will,  again,  sort all 
  152.             of  the  directories  on  disk  A  but  this  time in 
  153.             Date/Time order.  The "R" option would,  agan,  cause 
  154.             the  relative  sectors occupied by each directory and 
  155.             the number of entries removed to be displayed.  
  156.  
  157.